<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>three.interaction.js API Documentation</title>
    
    <meta name="description" content="Documentation for three.interaction.js library" />
    
        <meta name="keywords" content="docs, documentation, three.js, three.js event system, three.interaction.js, renderer, html5, javascript, jsdoc" />
        <meta name="keyword" content="docs, documentation, three.js, three.js event system, three.interaction.js, renderer, html5, javascript, jsdoc" />
    
    
    
    <meta property="og:title" content=""/>
    <meta property="og:type" content="website"/>
    <meta property="og:image" content=""/>
    
    <meta property="og:url" content=""/>
    
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <script src="scripts/jquery.min.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link href="https://fonts.googleapis.com/css?family=Libre+Franklin:400,700" rel="stylesheet">
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
    <link type="text/css" rel="stylesheet" href="styles/main.css">
    
    
    <script>
    var config = {"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles":true},"applicationName":"three.interaction.js","footer":"Made with ♥ by JasonChen (github.com/jasonChen1982)","copyright":"three.interaction.js Copyright © 2013-2017 JasonChen.","disqus":"","googleAnalytics":"UA-103772589-5","openGraph":{"title":"","type":"website","image":"","site_name":"","url":""},"meta":{"title":"three.interaction.js API Documentation","description":"Documentation for three.interaction.js library","keyword":"docs, documentation, three.js, three.js event system, three.interaction.js, renderer, html5, javascript, jsdoc"},"linenums":true};
    </script>
    

    
    <script type="text/javascript">
      var _gaq = _gaq || [];
      _gaq.push(['_setAccount', config.googleAnalytics]);
      _gaq.push(['_trackPageview']);
    
      (function() {
        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
      })();
    </script>
    
</head>
<body>
<div id="wrap" class="clearfix">
    
<div class="navigation">
    <h3 class="applicationName"><a href="index.html">three.interaction.js</a></h3>
    <button id="menuToggle" class="btn btn-link btn-lg menu-toggle">
        <span class="glyphicon glyphicon-menu-hamburger"></span>
    </button>
    <div class="search">
        <input id="search" type="text" class="form-control input-md" placeholder="Search...">
    </div>
    <ul class="list">
    
        <li class="item" data-name="Utils">
            <span class="title namespace ">
                
                <span class="namespaceTag">
                    <span class="glyphicon glyphicon-folder-open"></span>
                </span>
                
                <a href="Utils.html">Utils</a>
            </span>
            <ul class="members itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li class="parent  " data-name="Utils.isFunction"><a href="Utils.html#.isFunction">isFunction</a></li>
            
                <li class="parent  " data-name="Utils.isUndefined"><a href="Utils.html#.isUndefined">isUndefined</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="Interaction">
            <span class="title  ">
                
                <a href="Interaction.html">Interaction</a>
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li class=" " data-name="Interaction#autoPreventDefault"><a href="Interaction.html#autoPreventDefault">autoPreventDefault</a></li>
            
                <li class=" " data-name="Interaction#camera"><a href="Interaction.html#camera">camera</a></li>
            
                <li class=" " data-name="Interaction#currentCursorMode"><a href="Interaction.html#currentCursorMode">currentCursorMode</a></li>
            
                <li class=" " data-name="Interaction#cursorStyles"><a href="Interaction.html#cursorStyles">cursorStyles</a></li>
            
                <li class=" " data-name="Interaction#eventData"><a href="Interaction.html#eventData">eventData</a></li>
            
                <li class=" " data-name="Interaction#interactionFrequency"><a href="Interaction.html#interactionFrequency">interactionFrequency</a></li>
            
                <li class=" " data-name="Interaction#mouse"><a href="Interaction.html#mouse">mouse</a></li>
            
                <li class=" " data-name="Interaction#moveWhenInside"><a href="Interaction.html#moveWhenInside">moveWhenInside</a></li>
            
                <li class=" " data-name="Interaction#renderer"><a href="Interaction.html#renderer">renderer</a></li>
            
                <li class=" " data-name="Interaction#scene"><a href="Interaction.html#scene">scene</a></li>
            
                <li class=" " data-name="Interaction#supportsPointerEvents"><a href="Interaction.html#supportsPointerEvents">supportsPointerEvents</a></li>
            
                <li class=" " data-name="Interaction#supportsTouchEvents"><a href="Interaction.html#supportsTouchEvents">supportsTouchEvents</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li class="  " data-name="Interaction#destroy"><a href="Interaction.html#destroy">destroy</a></li>
            
                <li class="  " data-name="Interaction#emit"><a href="Interaction.html#emit">emit</a></li>
            
                <li class="  " data-name="Interaction#hitTest"><a href="Interaction.html#hitTest">hitTest</a></li>
            
                <li class="  " data-name="Interaction#mapPositionToPoint"><a href="Interaction.html#mapPositionToPoint">mapPositionToPoint</a></li>
            
                <li class="  " data-name="Interaction#off"><a href="Interaction.html#off">off</a></li>
            
                <li class="  " data-name="Interaction#on"><a href="Interaction.html#on">on</a></li>
            
                <li class="  " data-name="Interaction#once"><a href="Interaction.html#once">once</a></li>
            
                <li class="  " data-name="Interaction#setCursorMode"><a href="Interaction.html#setCursorMode">setCursorMode</a></li>
            
                <li class="  " data-name="Interaction#setTargetElement"><a href="Interaction.html#setTargetElement">setTargetElement</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="InteractionData">
            <span class="title  ">
                
                <a href="InteractionData.html">InteractionData</a>
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li class="parent " data-name="InteractionData#button"><a href="InteractionData.html#button">button</a></li>
            
                <li class="parent " data-name="InteractionData#buttons"><a href="InteractionData.html#buttons">buttons</a></li>
            
                <li class="parent " data-name="InteractionData#global"><a href="InteractionData.html#global">global</a></li>
            
                <li class="parent " data-name="InteractionData#height"><a href="InteractionData.html#height">height</a></li>
            
                <li class="parent " data-name="InteractionData#identifier"><a href="InteractionData.html#identifier">identifier</a></li>
            
                <li class="parent " data-name="InteractionData#isPrimary"><a href="InteractionData.html#isPrimary">isPrimary</a></li>
            
                <li class="parent " data-name="InteractionData#originalEvent"><a href="InteractionData.html#originalEvent">originalEvent</a></li>
            
                <li class="parent " data-name="InteractionData#pointerId"><a href="InteractionData.html#pointerId">pointerId</a></li>
            
                <li class="parent " data-name="InteractionData#pointerType"><a href="InteractionData.html#pointerType">pointerType</a></li>
            
                <li class="parent " data-name="InteractionData#pressure"><a href="InteractionData.html#pressure">pressure</a></li>
            
                <li class="parent " data-name="InteractionData#rotationAngle"><a href="InteractionData.html#rotationAngle">rotationAngle</a></li>
            
                <li class="parent " data-name="InteractionData#tangentialPressure"><a href="InteractionData.html#tangentialPressure">tangentialPressure</a></li>
            
                <li class="parent " data-name="InteractionData#target"><a href="InteractionData.html#target">target</a></li>
            
                <li class="parent " data-name="InteractionData#tiltX"><a href="InteractionData.html#tiltX">tiltX</a></li>
            
                <li class="parent " data-name="InteractionData#tiltY"><a href="InteractionData.html#tiltY">tiltY</a></li>
            
                <li class="parent " data-name="InteractionData#twist"><a href="InteractionData.html#twist">twist</a></li>
            
                <li class="parent " data-name="InteractionData#width"><a href="InteractionData.html#width">width</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="InteractionEvent">
            <span class="title  ">
                
                <a href="InteractionEvent.html">InteractionEvent</a>
            </span>
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li class="parent " data-name="InteractionEvent#currentTarget"><a href="InteractionEvent.html#currentTarget">currentTarget</a></li>
            
                <li class="parent " data-name="InteractionEvent#data"><a href="InteractionEvent.html#data">data</a></li>
            
                <li class="parent " data-name="InteractionEvent#intersects"><a href="InteractionEvent.html#intersects">intersects</a></li>
            
                <li class="parent " data-name="InteractionEvent#stopped"><a href="InteractionEvent.html#stopped">stopped</a></li>
            
                <li class="parent " data-name="InteractionEvent#target"><a href="InteractionEvent.html#target">target</a></li>
            
                <li class="parent " data-name="InteractionEvent#type"><a href="InteractionEvent.html#type">type</a></li>
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li class="parent  " data-name="InteractionEvent#stopPropagation"><a href="InteractionEvent.html#stopPropagation">stopPropagation</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
        <li class="item" data-name="Ticker">
            <span class="title  ">
                
                <a href="Ticker.html">Ticker</a>
            </span>
            <ul class="members itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="typedefs itemMembers">
            
            </ul>
            <ul class="methods itemMembers">
            
            <span class="subtitle">Methods</span>
            
                <li class="  " data-name="Ticker#emit"><a href="Ticker.html#emit">emit</a></li>
            
                <li class="  " data-name="Ticker#off"><a href="Ticker.html#off">off</a></li>
            
                <li class="  " data-name="Ticker#on"><a href="Ticker.html#on">on</a></li>
            
                <li class="  " data-name="Ticker#once"><a href="Ticker.html#once">once</a></li>
            
                <li class="parent  " data-name="Ticker#start"><a href="Ticker.html#start">start</a></li>
            
                <li class="parent  " data-name="Ticker#stop"><a href="Ticker.html#stop">stop</a></li>
            
            </ul>
            <ul class="events itemMembers">
            
            </ul>
        </li>
    
    </ul>
</div>
    <div class="main">
        <h1 class="page-title" data-filename="Ticker.html">Class: Ticker</h1>
        



<section>
    
<header>
    <div class="header content-size">
        <h2>Ticker
        </h2>
        
    </div>
</header>  

<article class="content-size">
    <div class="container-overview">
    
    
    
        
<dt>
    <div class="nameContainer">
        <h4 class="name" id="Ticker">
            <a class="share-icon" href="#Ticker"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">
                new Ticker
            </span>
            <span class="signature">()</span>
            
            
            
            
        </h4>
    
        
        <div class="tag-source">
            <a href="utils_Ticker.js.html#line7">Ticker.js:7</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    

    
    
    
    
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

    
    </div>
    
    
        <h3 class="subsection-title">Extends</h3>
        
        <ul>
            <li><a href="EventDispatcher.html">EventDispatcher</a></li>
        </ul>
    
    
    
    
    
    
    
    
    
    
    
    
    
        <h3 class="subsection-title">Methods</h3>
        
        <dl class="list-methods">
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id="emit">
            <a class="share-icon" href="#emit"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">
                emit
            </span>
            <span class="signature">(type)</span><span class="type-signature">this</span>
            
            
            
                <span class="access-signature inherited"><a href="EventDispatcher.html#emit">inherited</a></span>
            
            
        </h4>
    
        
        <div class="tag-source">
            <a href="patch_EventDispatcher.js.html#line53">EventDispatcher.js:53</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>emit a event</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>type</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>event type, evnet name</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    <h5>Returns:</h5>
    


<table class="params">
    <thead>
    <tr>
        
        <th>Type</th>
        <th class="last">Description</th>
    </tr>
    </thead>
    <tbody>
    
        <tr>
            
            <td class="type">
            
                        this
                        
                    
            </td>
            <td class="description last">this</td>
        </tr>
    
    </tbody>
</table>

    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id="off">
            <a class="share-icon" href="#off"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">
                off
            </span>
            <span class="signature">(type, fn)</span><span class="type-signature">this</span>
            
            
            
                <span class="access-signature inherited"><a href="EventDispatcher.html#off">inherited</a></span>
            
            
        </h4>
    
        
        <div class="tag-source">
            <a href="patch_EventDispatcher.js.html#line25">EventDispatcher.js:25</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>proxy <code>removeEventListener</code> function</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>type</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>event type, evnet name</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>fn</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>callback, which you had bind before</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    <h5>Returns:</h5>
    


<table class="params">
    <thead>
    <tr>
        
        <th>Type</th>
        <th class="last">Description</th>
    </tr>
    </thead>
    <tbody>
    
        <tr>
            
            <td class="type">
            
                        this
                        
                    
            </td>
            <td class="description last">this</td>
        </tr>
    
    </tbody>
</table>

    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id="on">
            <a class="share-icon" href="#on"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">
                on
            </span>
            <span class="signature">(type, fn)</span><span class="type-signature">this</span>
            
            
            
                <span class="access-signature inherited"><a href="EventDispatcher.html#on">inherited</a></span>
            
            
        </h4>
    
        
        <div class="tag-source">
            <a href="patch_EventDispatcher.js.html#line11">EventDispatcher.js:11</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>proxy <code>addEventListener</code> function</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>type</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>event type, evnet name</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>fn</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>callback</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    <h5>Returns:</h5>
    


<table class="params">
    <thead>
    <tr>
        
        <th>Type</th>
        <th class="last">Description</th>
    </tr>
    </thead>
    <tbody>
    
        <tr>
            
            <td class="type">
            
                        this
                        
                    
            </td>
            <td class="description last">this</td>
        </tr>
    
    </tbody>
</table>

    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id="once">
            <a class="share-icon" href="#once"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">
                once
            </span>
            <span class="signature">(type, fn)</span><span class="type-signature">this</span>
            
            
            
                <span class="access-signature inherited"><a href="EventDispatcher.html#once">inherited</a></span>
            
            
        </h4>
    
        
        <div class="tag-source">
            <a href="patch_EventDispatcher.js.html#line37">EventDispatcher.js:37</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>binding a once event, just emit once time</p>
    </div>
    

    
    
    
    
    
        

<table class="params">
    <thead>
	<tr>
		
		<th>Name</th>
		
		
		<th>Type</th>
		
		
		
		<th class="last">Description</th>
	</tr>
	</thead>
	
	<tbody>
	
	
        <tr>
            
                <td class="name"><code>type</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>event type, evnet name</p></td>
        </tr>
	
	
	
        <tr>
            
                <td class="name"><code>fn</code></td>
            
            
            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>
            
            
            
            <td class="description last">
                
                <p>callback</p></td>
        </tr>
	
	
	</tbody>
</table>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    <h5>Returns:</h5>
    


<table class="params">
    <thead>
    <tr>
        
        <th>Type</th>
        <th class="last">Description</th>
    </tr>
    </thead>
    <tbody>
    
        <tr>
            
            <td class="type">
            
                        this
                        
                    
            </td>
            <td class="description last">this</td>
        </tr>
    
    </tbody>
</table>

    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id="start">
            <a class="share-icon" href="#start"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">
                start
            </span>
            <span class="signature">()</span>
            
            
            
            
        </h4>
    
        
        <div class="tag-source">
            <a href="utils_Ticker.js.html#line38">Ticker.js:38</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>start tick loop</p>
    </div>
    

    
    
    
    
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

        
            
<dt>
    <div class="nameContainer">
        <h4 class="name" id="stop">
            <a class="share-icon" href="#stop"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">
                stop
            </span>
            <span class="signature">()</span>
            
            
            
            
        </h4>
    
        
        <div class="tag-source">
            <a href="utils_Ticker.js.html#line51">Ticker.js:51</a>
        </div>
        
    </div>

    
</dt>
<dd>
    
    
    <div class="description">
        <p>stop tick loop</p>
    </div>
    

    
    
    
    
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    

    

    
    
    
    
    
    
    
</dd>

        </dl>
    
    
    
    
    

    
</article>

</section>  





        

        <footer class="content-size">
            <div class="footer">
                Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jul 24 2020 12:41:12 GMT+0800 (GMT+08:00)
            </div>
        </footer>
    </div>
</div>
<script>prettyPrint();</script>
<script src="scripts/main.js"></script>
</body>
</html>